Tạo Bot

Khi bạn muốn tạo Bot để phục vụ cho một usecase trong hệ thống của bạn. Bạn có thể tạo Bot thông qua API mà PiScale cung cấp

HTTP request

POST https://{app_id}.api.piscale.com/chat-bot/v1.0/bots

Request body

Ví dụ

{
    "user_id": "",
    "display_name": "Bot Chăm Sóc Khách Hàng",
    "description": "",
    "avatar_url": "https://images.samsung.com/is/image/samsung/assets/vn/about-us/brand/logo/mo/256_144_3.png",
    "is_global": 1,
    "type": 1,
    "config": {
        "webhook_url": "https://be87-2405-4803-f7fb-8570-8d9e-c024-84e7-953b.ngrok.io/api/webhook",
        "receive_all_msg": 1
    }
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
user_id	string	Id trong hệ thống của bạn, nếu không truyền PiScale sẽ tạo một id cho bot	✗
display_name	string	Tên hiển thị của bot	✓
avatar_url	string	Url ảnh đại diện của bot	✗
description	string	Mô tả bot	✗
is_global	int	Phạm vi hoạt động của bot	✗
config.webhook_url	string	Thiết lập endpoint mà bạn muốn nhận được event	✗
type	int	Loại bot. type = 1. Trong trường hợp bạn muốn tạo AI Bot hoặc Flow Bot thì vui lòng truy cập vào dashboard.	✗
config.receive_all_msg	int	Nếu bạn muốn nhận được tất cả tin nhắn trong cuộc hội thoạt có bot thì thiết lập giá trị là 1. Mặc định PiScale sẽ đẩy dữ liệu về đầu webhook nếu phát hiện Bot được nhắc đến hoặc tin nhắn chứa command	✗

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ

{
    "message_code": "M200",
    "message": "Success",
    "data": {
        "user_id": "5CEAL1bPI6:1697012858",
        "display_name": "Bot Chăm Sóc Khách Hàng",
        "description": "",
        "avatar_url": "https://images.samsung.com/is/image/samsung/assets/vn/about-us/brand/logo/mo/256_144_3.png",
        "status": 1,
        "created_at": 1697012858016,
        "updated_at": 1697012858016,
        "config": {
            "webhook_url": "https://be87-2405-4803-f7fb-8570-8d9e-c024-84e7-953b.ngrok.io/api/webhook",
            "receive_all_msg": 1
        },
        "token": "6872016393686756:u1r9NLQijr58lrEGDG789jHskksWl6WjLTa",
        "ext_bot_id": "6872016393686756",
        "is_global": 1
    }
}

Bạn cần lưu ý những tham số sau:

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp
data.token	string	Đây là dữ liệu rất quan trọng, dữ liệu này dùng để xác thực các đầu api về các tác vụ của bot như việc gửi tin nhắn, tạo cuộc hội thoại
data.ext_bot_id	string	Id của bot.
data.is_global	int	Phạm vi hoạt động của bot. Nếu is_global = 1 thì bot sẽ hoạt động với phạm vi của toàn app
data.status	int	Trạng thái của bot. active = 1, inactive = 2